What Are Webhooks?

Webhooks are a way for a Tilte system to provide real-time information to the users. They allow one system to send automated messages or data to another system when a specific event occurs. A webhook is a lightweight API that allows for immediate notifications and interactions between systems.

In this webhook guide, we will explore the following:

• What is a Webhook?

• Uses of Webhooks

• How Webhooks Work?

• Types of Events

What is a Webhook?

A webhook is an HTTP-based callback function that enables lightweight, event-driven communication between two application programming interfaces (APIs). When a specified event occurs in the Tilte application, a webhook sends a notification to a designated URL in another application or a subscriber/user, delivering data in the form of a payload, typically formatted as JSON or XML. This mechanism allows applications to react to events in real-time, making webhooks a valuable alternative to traditional APIs, which often require polling for updates.

Uses of Webhooks

Webhooks are utilized in various scenarios, including:

• Notifications: Send alerts to collaboration platforms (e.g., Tilte) when specific events happen, like sending messages or receiving messages.

• Data Synchronization: Updating external systems (e.g., Tilte) based on events in the primary application.

• Real-time User Interactions: Notifying applications when users perform actions, such as checking into a message or creating a message.

How Webhooks Work?

• Webhook Setup: The application that needs to send notifications (the sender) will have a webhook configured. This involves specifying a URL (the endpoint) where the data should be sent. The application that wants to receive notifications (the receiver) sets up an endpoint to listen for incoming webhook messages.

• Event Occurs: When a predefined event happens in the sender application (e.g., a new user signs up, a payment is processed), the sender application triggers the webhook.

• Send Data: The sender application sends an HTTP request (usually a POST request) to the receiver's endpoint URL. This request contains data about the event in the body of the request.

• Receive and Process Data: The receiver application receives the request and processes the data. This might involve updating a database, triggering further actions, or sending a notification to a user.

• Response (Optional): The receiver can respond to the sender with an acknowledgment or error message, confirming that the data was received and processed correctly.

The webhooks that are supported by the Tilte platform are detailed below. This data is used as post-back data for a triggered webhook.

Since webhook notifications are dispatched when certain event(s) happen, for some event types notifications are placed in batches. This applies to all notifications that could be sent in large numbers within a small amount of time.

Types of Events

Subscribe event

Subscribing to events via webhooks allows your application to receive real-time notifications whenever specific actions occur in our system. This enables you to automate workflows, synchronize data, and enhance user experiences without the need for constant polling.

Update subscriber event

UpdateSubscriber event is designed to notify systems and applications when a subscriber's information has been modified. This can include updates to personal details, preferences, subscription status, or any other relevant attributes. By capturing these updates in real-time, applications can maintain accurate records, trigger additional workflows, and ensure that subscribers receive the correct communications based on their current status.

Sample update subscriber event notification

Unsubscribe event

The Unsubscribe event helps to notify systems and applications when a subscriber has chosen to withdraw their consent to receive communications.

Address suppression event

Address suppression event helps to inform systems when a specific email address has been suppressed. This suppression typically occurs when a user has unsubscribed, marked emails as spam, or when the email address is identified as invalid (e.g., hard bounces). The primary goal is to prevent future communications to these addresses, ensuring compliance with regulations and maintaining a positive sender reputation.

Message open event

Message open event helps to notify systems when a recipient opens an email or message. This event is essential for measuring engagement and effectiveness in email campaigns. By tracking opens, Tilte can assess the performance of their messages, understand recipient behavior, and refine their marketing strategies accordingly.

Message click event

Message click event helps to notify systems when a recipient interacts with a message by clicking on it. This interaction can provide valuable insights into user behavior, allowing organizations to understand which messages or content types are most engaging. By tracking clicks, businesses can optimize their messaging strategies and improve overall user experience.

Message delivered event

Message delivered event is a notification that indicates a message has been successfully delivered to a recipient's device. This event is important for tracking the effectiveness of messaging campaigns and ensuring that communications reach their intended audience.

Message bounced event

The MessageBounced event is a notification that indicates a message sent to a recipient could not be delivered and has "bounced" back. This event is important for managing email communication and understanding the effectiveness of messaging campaigns.

Campaign sent event

The CampaignSent event helps to inform systems when a specific marketing campaign, such as an email blast or direct mail, has been sent out. This event is essential for measuring the effectiveness of trade efforts, ensuring that the intended audience receives the communication, and facilitating further analysis of campaign performance.

Campaign stats updated event

Campaign stats updated event is a notification that indicates changes have been made to the statistics or metrics of a marketing campaign. This event is important for tracking the performance and effectiveness of campaigns over time.